gridpack::mapper::BusVectorMap< _network > Class Template Reference

#include <bus_vector_map.hpp>

Collaboration diagram for gridpack::mapper::BusVectorMap< _network >:

[legend]

List of all members.

Public Member Functions
	BusVectorMap (boost::shared_ptr< _network > network)
	~BusVectorMap ()
boost::shared_ptr < gridpack::math::Vector >	mapToVector (void)
boost::shared_ptr < gridpack::math::RealVector >	mapToRealVector (void)
gridpack::math::Vector *	intMapToVector (void)
void	mapToVector (gridpack::math::Vector &vector)
void	mapToRealVector (gridpack::math::RealVector &vector)
void	mapToVector (boost::shared_ptr< gridpack::math::Vector > &vector)
void	mapToRealVector (boost::shared_ptr< gridpack::math::RealVector > &vector)
void	mapToBus (const gridpack::math::Vector &vector)
void	mapToBus (const gridpack::math::RealVector &vector)
void	mapToBus (boost::shared_ptr< gridpack::math::Vector > &vector)
void	mapToBus (boost::shared_ptr< gridpack::math::RealVector > &vector)

template<class _network>
class gridpack::mapper::BusVectorMap< _network >

---

Constructor & Destructor Documentation

template<class _network>

gridpack::mapper::BusVectorMap< _network >::BusVectorMap

(

boost::shared_ptr< _network >

network

)

Initialize mapper for the given network and the current mode. Create global arrays that contain offsets that will be used to create vector from the network component objects

Parameters:

network

network that will generate vector

References gridpack::utility::CoarseTimer::instance().

template<class _network>

gridpack::mapper::BusVectorMap< _network >::~BusVectorMap

(

)

---

Member Function Documentation

template<class _network>

gridpack::math::Vector* gridpack::mapper::BusVectorMap< _network >::intMapToVector

(

void

)

Create a vector from the current bus state and return a conventional pointer to it. Used for Fortran interface

Returns:

return pointer to new vector

References gridpack::utility::CoarseTimer::createCategory(), gridpack::utility::CoarseTimer::start(), and gridpack::utility::CoarseTimer::stop().

template<class _network>

void gridpack::mapper::BusVectorMap< _network >::mapToBus

(

boost::shared_ptr< gridpack::math::RealVector > &

vector

)

References gridpack::mapper::BusVectorMap< _network >::mapToBus().

template<class _network>

void gridpack::mapper::BusVectorMap< _network >::mapToBus

(

boost::shared_ptr< gridpack::math::Vector > &

vector

)

Push data from vector onto buses. Vector must be created with the mapToVector method using the same BusVectorMap

Parameters:

vector

vector containing data to be pushed to buses

References gridpack::mapper::BusVectorMap< _network >::mapToBus().

template<class _network>

void gridpack::mapper::BusVectorMap< _network >::mapToBus

(

const gridpack::math::RealVector &

vector

)

Push data from vector onto buses. Vector must be created with the mapToVector method using the same BusVectorMap

Parameters:

vector

vector containing data to be pushed to buses

References gridpack::utility::CoarseTimer::createCategory(), gridpack::component::MatVecInterface::setValues(), gridpack::utility::CoarseTimer::start(), and gridpack::utility::CoarseTimer::stop().

template<class _network>

void gridpack::mapper::BusVectorMap< _network >::mapToBus

(

const gridpack::math::Vector &

vector

)

Push data from vector onto buses. Vector must be created with the mapToVector method using the same BusVectorMap

Parameters:

vector

vector containing data to be pushed to buses

References gridpack::utility::CoarseTimer::createCategory(), gridpack::component::MatVecInterface::setValues(), gridpack::utility::CoarseTimer::start(), and gridpack::utility::CoarseTimer::stop().

template<class _network>

void gridpack::mapper::BusVectorMap< _network >::mapToRealVector

(

boost::shared_ptr< gridpack::math::RealVector > &

vector

)

Reset a vector from the current bus state (vector should be created with same mapper).

Parameters:

vector

existing vector that should be reset

References gridpack::mapper::BusVectorMap< _network >::mapToRealVector().

template<class _network>

void gridpack::mapper::BusVectorMap< _network >::mapToRealVector

(

gridpack::math::RealVector &

vector

)

Reset a vector from the current bus state (vector should be created with same mapper)

Parameters:

vector

existing vector that should be reset

References gridpack::utility::CoarseTimer::createCategory(), gridpack::utility::CoarseTimer::start(), and gridpack::utility::CoarseTimer::stop().

template<class _network>

boost::shared_ptr<gridpack::math::RealVector> gridpack::mapper::BusVectorMap< _network >::mapToRealVector

(

void

)

Create a vector from the current bus state

Returns:

return pointer to new vector

References gridpack::utility::CoarseTimer::createCategory(), gridpack::utility::CoarseTimer::start(), and gridpack::utility::CoarseTimer::stop().

template<class _network>

void gridpack::mapper::BusVectorMap< _network >::mapToVector

(

boost::shared_ptr< gridpack::math::Vector > &

vector

)

Reset a vector from the current bus state (vector should be created with same mapper).

Parameters:

vector

existing vector that should be reset

References gridpack::mapper::BusVectorMap< _network >::mapToVector().

template<class _network>

void gridpack::mapper::BusVectorMap< _network >::mapToVector

(

gridpack::math::Vector &

vector

)

Reset a vector from the current bus state (vector should be created with same mapper)

Parameters:

vector

existing vector that should be reset

References gridpack::utility::CoarseTimer::createCategory(), gridpack::utility::CoarseTimer::start(), and gridpack::utility::CoarseTimer::stop().

template<class _network>

boost::shared_ptr<gridpack::math::Vector> gridpack::mapper::BusVectorMap< _network >::mapToVector

(

void

)

Create a vector from the current bus state

Returns:

return pointer to new vector

References gridpack::utility::CoarseTimer::createCategory(), gridpack::utility::CoarseTimer::start(), and gridpack::utility::CoarseTimer::stop().

---

The documentation for this class was generated from the following file:

• bus_vector_map.hpp